Using Open API with Org Units

This article includes instructions on how to review your API configuration with your IT team post Org Unit migration.

OVERVIEW

Namely's Open API enables organizations to call Org Units through the Groups endpoint for integration purposes. If you're utilizing our Org Units feature and leveraging our open API, work with your IT team to re-configure your organization's endpoints to ensure that the correct Org Type names are being referenced.

TIP:

If you integrate with one of our partners, no action is required! 

 

ORG UNITS AND OPEN API

You may notice that your organization's default Org Types (Departments, Divisions, and Office Locations) are automatically pluralized following the update to your company's Org Units. If this occurs, reach out to your IT team to review your API endpoints configuration. You should use the API to view details of group types, groups, and teams (including their members).



For each of the below endpoints, you will need to append the request with "https://yourcompany.namely.com/api/v1" and end the request with ".json".

• Example: https://yourcompany.namely.com/api/v1/groups.json

Method	Endpoint	Usage	Returns
GET	/group_types	Show a list of group types	group types
GET	/group_types/{id}	Show details of a group type	group type
GET	/groups	Show a list of groups	groups
GET	/groups/{id}	Show details of a group	group
GET	/teams	Show a list of teams	teams
GET	/teams/{id}	Show details of a team	team
GET	/profiles	Get a list of profiles at your company	profiles*
GET	/profiles/{id}	Get a profile from your company	profile*
GET	/profiles/me	Get current user's profile	profile*

*Endpoints potentially include responses that pertain to groups and teams. 

 

THINGS TO CONSIDER

• Group Types include Departments, Divisions, and Office Locations.

• As part of our Okta Integration, Group and Org Units create groups automatically in Okta but only the Departments field appears as a user attribute in Okta.